﻿/*
 * Copyright (c) 2015-2016 Constantijn Evenhuis (blueprints@const.nl)
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
using System;

namespace Blueprints
{
    /// <summary>
    /// An exception during the serialization process of blueprints.
    /// </summary>
    public sealed class BlueprintDocumentException : BlueprintException
    {
        /// <summary>
        /// Decorates a BlueprintException with a path within the blueprint.
        /// </summary>
        /// <param name="exception">The BlueprintException to decorate.</param>
        /// <param name="path">The path in the blueprint document at which the exception occurred.</param>
        internal BlueprintDocumentException(BlueprintException exception, string path)
            : base(exception.Message + "\r\n  at " + path, exception)
        {
            Path = path;
        }

        /// <summary>
        /// Creates a new blueprint exception.
        /// </summary>
        /// <param name="message">The exception message.</param>
        /// <param name="path">The path in the blueprint document at which the exception occurred.</param>
        public BlueprintDocumentException(string message, string path)
            : base(message)
        {
            Path = path;
        }

        /// <summary>
        /// Creates a new blueprint exception.
        /// </summary>
        /// <param name="message">The exception message.</param>
        /// <param name="path">The path in the blueprint document at which the exception occurred.</param>
        /// <param name="innerException">The inner exception.</param>
        public BlueprintDocumentException(string message, string path, Exception innerException)
            : base(message, innerException)
        {
            Path = path;
        }

        /// <summary>
        /// Gets the path in the blueprint at which the exception occurred.
        /// </summary>
        public string Path
        {
            get;
            private set;
        }
    }
}